Skip to content

Lissy93/portainer-templates

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Portainer Templates

A compiled list of 500+ ready to go Portainer App templates

🌐 portainer-templates.as93.net

TL;DR Under Settings → App Templates in your Portainer GUI, paste this URL:
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json

Contents

Intro

In Portainer, App Templates enable you to easily deploy services with a predetermined configuration, while allowing you to customize options through the web UI. While Portainer ships with some default templates (see portainer/templates), it's often helpful to have 1-click access to many more apps + stacks, without having to constantly switch template sources.

This repo combines app templates from several sources, to create a ready-to-go template file containing all the apps you'll ever need. It's also possible to self-host, as well as combine with your own custom templates.

You can browse all supported apps and stacks and see stats, config options and stand-alone installation commands for each, at portainer-templates.as93.net


Usage

  1. Log into your Portainer web UI
  2. Under Settings --> App Templates, update the URL to
    • https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
  3. Now under Home --> App Templates, you should see all apps. Click one to deploy.
Show me...

Alternatively, when you start Portainer, you can append the --templates flag pointing to the templates URL.


Self-Hosting

If you'd prefer to source templates locally, you can self-host with Docker - there's a sample NGINX container provided
Just run: docker run -p 8080:80 lissy93/portainer-templates (changing 8080 to a port of your choice)
You'll then be able to pass Portainer the template file located at http://[host]:[port]/templates.json

Alternatively, you can build the image yourself locally, with the following commands (if you're using your own fork, don't forget to switch lissy93 out for your username!)

git clone https://github.com/lissy93/portainer-templates.git
cd portainer-templates
docker build -t portainer-templates .
docker run -d -p "8080:80" portainer-templates

If you're using your own template file, but don't want to fork this repository, you can instead simply pass your templates.json file to the above Docker container as a volume, with -v "${PWD}/templates.json:/usr/share/nginx/html/templates.json"


Editing

The template.json file is generated using the scripts in lib, using GitHub Actions. Running the make command will download all listed sources, parse them, and combine them with anything in the sources dir, outputting the templates.json file.
So, you only need to edit either the sources.csv file, or add your templates directly into the sources/ directory.

Adding a new Source

If you're maintaining your own list of Portainer templates, and would like them to be included, just add the URL to your template.json file to sources.csv, along with a name. When the action runs, it will download the content, parse it and add it to the final template.

Adding a Template / Template list

Alternatively, place your template file within the sources directory, and it will be automatically combined into the main template.json. Be sure that your template corresponds to Portainer's App Template JSON Format.

Validating Templates

There is a schema defined in Schema.json, which can be used to validate any Portainer template. Run make validate to ensure your template conforms to Portainer's App Template specification.

Maintaining your own Templates

If you'd like to use this repo as a base, but maintain your own list of template, just fork the repository, and update lissy93 with your username in the import URL.


Supported Apps and Stacks


↕️ Click to Expand ↕️

Click an item, to see stats, config options and installation instructions

  1. Activepieces
  2. Actual
  3. Adguard
  4. Adguardhome
  5. Adguardhome-Sync
  6. Airsonic
  7. Airsonic-Advanced
  8. Alpine Xfce4 Novnc
  9. Altus
  10. Ansible-Semaphore
  11. Apache Httpd
  12. Apprise-Api
  13. Appsmith
  14. Appwrite
  15. Archisteamfarm
  16. Archivebox
  17. Ardour
  18. Aria2 Pro
  19. Ariang
  20. Asciinema {Shmolf}
  21. Audacity
  22. Audiobookshelf
  23. Authelia
  24. Authentik
  25. Autobrr
  26. Babybuddy
  27. Baikal
  28. Bambustudio
  29. Baserow
  30. Bazarr
  31. Beets
  32. Bitwarden Rs
  33. Blender
  34. Boinc
  35. Booksonic
  36. Booksonic-Air
  37. Bookstack
  38. Broadlink Manager
  39. Budge
  40. Budibase
  41. Build-Agent
  42. Caddy
  43. Calibre
  44. Calibre-Web
  45. Calligra
  46. Cardigann
  47. Castopod
  48. Changedetection
  49. Changedetection.Io
  50. Chevereto
  51. Chibisafe
  52. Chiefonboarding
  53. Chowdown
  54. Chromium
  55. Chrony Ntp
  56. Ci
  57. Clamav
  58. Cloud Commander
  59. Cloud9
  60. Cloudflare Ddns
  61. Cockpit {Shmolf}
  62. Cockroachdb
  63. Code-Server
  64. Codex
  65. Codiad
  66. Commandbox
  67. Contentbox
  68. Cops
  69. Couchpotato
  70. Cratedb
  71. Cryptofolio
  72. Cura
  73. Daapd
  74. Darktable
  75. Dashdot
  76. Dashmachine
  77. Dashy
  78. Datadog Agent
  79. Davinci Postgres Server
  80. Davos
  81. Ddclient
  82. Deemix
  83. Deluge
  84. Deluge Openvpn
  85. Digikam
  86. Diskover
  87. Docker Container Stats
  88. Dockge
  89. Documize
  90. Dokemon
  91. Dokku
  92. Dokuwiki
  93. Domoticz
  94. Doplarr
  95. Doublecommander
  96. Dozzle
  97. Dradis
  98. Draw.Io
  99. Droppy
  100. Drupal
  101. Duckdns
  102. Duplicacy
  103. Duplicati
  104. Eclipse Mosquitto Mqtt
  105. Edgeconnector 840D
  106. Edgeconnector Aggregator
  107. Edgeconnector Fanuc Cnc
  108. Edgeconnector Modbus
  109. Edgeconnector Siemens
  110. Elasticsearch
  111. Emby
  112. Embystat
  113. Emulatorjs
  114. Endlessh
  115. Eufy Security Ws
  116. Excalidraw
  117. Fail2Ban
  118. Faster-Whisper
  119. Fdo
  120. Feed2Toot
  121. Feedcord
  122. Fenrus
  123. Ferdi Server
  124. Ferdium
  125. Fetchcord
  126. Ffmpeg
  127. File Browser
  128. Filebrowser Latest
  129. Filebrowser S6
  130. Filepizza
  131. Filerun
  132. Filestash
  133. Filezilla
  134. Firefox
  135. Fireshare
  136. Flame
  137. Flame-Dashboard
  138. Flaresolverr
  139. Fleet
  140. Flexget
  141. Floating License Server
  142. Flood
  143. Flowiseai
  144. Foldingathome
  145. Foundryvtt Server
  146. Freeboard
  147. Freecad
  148. Freescout
  149. Freetube
  150. Freshrss
  151. Frigate Nvr
  152. Funkwhale
  153. Gaps
  154. Gazee
  155. Ghost
  156. Ghostfolio
  157. Gimp
  158. Gitea
  159. Github-Desktop
  160. Gitlab Ce
  161. Gitqlient
  162. Glances
  163. Go-Socks5-Proxy
  164. Gokapi
  165. Gotify
  166. Grafana
  167. Grav
  168. Grocy
  169. Guacamole
  170. Habridge
  171. Hasty-Paste
  172. Hauk
  173. Headphones
  174. Healthchecks
  175. Hedgedoc
  176. Heimdall
  177. Hishtory-Server
  178. Homarr
  179. Homarr-Secured
  180. Home Assistant
  181. Homebridge
  182. Homebridge - Debian
  183. Homechart
  184. Homepage
  185. Homer
  186. Htpcmanager
  187. Httpd
  188. Huginn
  189. Hydra2
  190. I Hate Money
  191. Immich
  192. Immich {Shmolf}
  193. Influxdb
  194. Influxdb & Telegraf
  195. Influxdb 1.8.10
  196. Inkscape
  197. Invidious
  198. Invoice Ninja
  199. Iobroker
  200. Iperf
  201. Ironfunctions
  202. Ironfunctions Api
  203. Ironfunctions Ui
  204. Jackett
  205. Jdownloader
  206. Jellyfin
  207. Jellyfin-Accounts
  208. Jellyseer
  209. Jellyseerr
  210. Jenkins
  211. Jenkins-Builder
  212. Joomla
  213. Joplin
  214. Jump
  215. Kanzi
  216. Kapowarr
  217. Kasm
  218. Kavita
  219. Kdenlive
  220. Keepassxc
  221. Kicad
  222. Kimai
  223. Kiwix
  224. Klaxon
  225. Klipper[Testing], Mainsail, Moonraker
  226. Kodi-Headless
  227. Koillection
  228. Kometa
  229. Komga
  230. Krita
  231. Lazylibrarian
  232. Lazytainer
  233. Ldap-Auth
  234. Leantime
  235. Let'S Encrypt / Swag
  236. Letsencrypt
  237. Libreddit
  238. Libreoffice
  239. Libresonic
  240. Librespeed
  241. Librewolf
  242. Lidarr
  243. Limnoria
  244. Linkstack
  245. Littlelink Server
  246. Liveswitch
  247. Lldap
  248. Logzio Logs Collector
  249. Logzio Metrics Collector
  250. Lollypop
  251. Lychee
  252. Magento 2
  253. Magicmirror2
  254. Mailpile
  255. Maloja
  256. Mariadb
  257. Mastodon
  258. Matomo
  259. Mautic
  260. Mayan Edms
  261. Mcmyadmin 2
  262. Mealie
  263. Mediaelch
  264. Medusa
  265. Meilisearch
  266. Meshcentral
  267. Metube
  268. Microsoft Oms Agent
  269. Midarr
  270. Minecraft Server
  271. Minetest
  272. Miniflux
  273. Minio
  274. Minisatip
  275. Mongo
  276. Monica
  277. Moodle
  278. Mozilla Syncserver
  279. Msedge
  280. Mstream
  281. Mullvad-Browser
  282. Murmur
  283. Musicbrainz
  284. Muximux
  285. Mylar
  286. Mylar3
  287. Mysql
  288. Mysql-Workbench
  289. N8N
  290. Nano
  291. Nano-Wallet
  292. Navidrome
  293. Neko
  294. Netalertx
  295. Netboot.Xyz
  296. Netbox
  297. Netdata
  298. Nextcloud
  299. Nextcloudstack
  300. Nginx
  301. Nginx Proxy Manager
  302. Nginx Proxy Manager V2 With Sqlite And Goaccess Charts
  303. Nginx Proxy Manager V2 With Sqllite
  304. Nginx Proxy Manager V3 [Devel] Not Ready For Use
  305. Ngircd
  306. Nitter
  307. Nocodb
  308. Node Red
  309. Nodejs
  310. Nord-Vpn
  311. Nut Server
  312. Nuts
  313. Nzbget
  314. Nzbhydra2
  315. Obsidian
  316. Octoprint
  317. Odoo
  318. Omada Eap Controller
  319. Ombi
  320. Opc Router
  321. Openamt
  322. Openbudgeteer
  323. Openfaas
  324. Openssh-Server
  325. Openvpn Access Server
  326. Openvpn-As
  327. Openvscode-Server
  328. Opera
  329. Opnform
  330. Orcaslicer
  331. Organizr
  332. Organizr V2
  333. Ory Kratos (Oathkeeper)
  334. Ory Kratos (Standalone)
  335. Oscam
  336. Outline
  337. Overseerr
  338. Owncloud
  339. Pairdrop
  340. Paperless Ngx
  341. Paperless-Ng
  342. Papermerge
  343. Passbolt
  344. Passky Client
  345. Passky Server
  346. Penpot (Http) {Shmolf}
  347. Petio
  348. Pgadmin
  349. Photoprism
  350. Photoshow
  351. Phpmyadmin
  352. Pi-Hole
  353. Pi-Hole Doh/Dot
  354. Pi-Hole-Unbound
  355. Pi.Alert
  356. Pidgin
  357. Pingvin
  358. Piper
  359. Piwigo
  360. Pixapop
  361. Pixel-Server
  362. Plane
  363. Plesk
  364. Plex
  365. Plex Media Server
  366. Plex Requests
  367. Plex-Meta-Manager
  368. Plextraktsync
  369. Plone
  370. Portainer Agent
  371. Poste.Io
  372. Postgresql
  373. Pritunl
  374. Privatebin
  375. Pro Mosquitto With Management Center
  376. Projectsend
  377. Protonmail Bridge
  378. Prowlarr
  379. Proxitok
  380. Pure-Ftp Server
  381. Pve-Exporter
  382. Pwndrop
  383. Pydio
  384. Pydio-Cells
  385. Pyload-Ng
  386. Pylon
  387. Python
  388. Qbittorrent
  389. Qdirstat
  390. Qflood
  391. Quassel Irc
  392. Quassel-Core
  393. Quassel-Web
  394. Rabbitmq
  395. Radarr
  396. Raneto
  397. Raspberry Pi Docker Monitor
  398. Rclone Config Backup
  399. Rdesktop
  400. Reactive-Resume
  401. Readarr
  402. Readme-Sync
  403. Redis
  404. Redis Cluster
  405. Redmine
  406. Registry
  407. Registry (Cache)
  408. Remmina
  409. Remotely
  410. Requestrr
  411. Resilio-Sync
  412. Reveal.Js
  413. Rocket Chat
  414. Rport
  415. Rsnapshot
  416. Rustdesk
  417. Rutorrent
  418. Sabnzbd
  419. Samba
  420. Scality S3
  421. Scrutiny
  422. Searxng
  423. Sematext Docker Agent
  424. Series-Troxide
  425. Servas
  426. Shaarli
  427. Shiori
  428. Shotcut
  429. Sickchill
  430. Sickgear
  431. Sickrage
  432. Signal Proxy
  433. Silverstripe
  434. Smokeping
  435. Snapdrop
  436. Snibox
  437. Snipe-It
  438. Snippet-Box
  439. Socket-Proxy
  440. Softing Edgeconnector 840D
  441. Softing Edgeconnector Aggregator
  442. Softing Edgeconnector Fanuc Cnc
  443. Softing Edgeconnector Modbus
  444. Softing Edgeconnector Siemens
  445. Solr
  446. Sonarr
  447. Speedtest Tracker
  448. Spotube
  449. Sql Server
  450. Sql Server Express
  451. Sqlitebrowser
  452. Sshwifty
  453. Stash
  454. Statping
  455. Steamos
  456. Stirling Pdf {Shmolf}
  457. Stirling-Pdf
  458. Surrealdb
  459. Swag
  460. Swarm Monitoring
  461. Synclounge
  462. Syncthing
  463. Syslog-Ng
  464. System Stats Oled Display
  465. Tabby
  466. Tailscale
  467. Tandoor
  468. Tautulli
  469. Tdarr
  470. Teleport
  471. Terraria Server {Shmolf}
  472. Tester
  473. Thelounge
  474. Tiddlywiki
  475. Timetagger
  476. Tiny Tiny Rss
  477. Tooljet
  478. Tosibox Lock For Container
  479. Traefik
  480. Traggo
  481. Transmission
  482. Transmission Openvpn Latest
  483. Transmission Openvpn V3
  484. Transmission-Openvpn
  485. Trilium
  486. Trudesk
  487. Tubearchivist
  488. Tvheadend
  489. Twitch Points Miner
  490. Ubooquity
  491. Ubuntu
  492. Umami.Is
  493. Unifi Video
  494. Unifi-Controller
  495. Unifi-Network-Application
  496. Unmanic
  497. Unrar
  498. Upsnap
  499. Uptime Kuma
  500. Urbackup
  501. Urlwatch
  502. Vaultwarden
  503. Vikunja
  504. Vlmcsd - Kms
  505. Vscodium
  506. Vsftpd Ftp Server
  507. Wallabag
  508. Watchtower
  509. Watchtower {Shmolf}
  510. Webcord
  511. Webgrabplus
  512. Webtop
  513. Webtrees
  514. Wger
  515. Whisparr
  516. Whoogle
  517. Wikijs
  518. Wireguard
  519. Wireguard Server
  520. Wireshark
  521. Wizarr
  522. Wordpress
  523. Wowza
  524. Wps-Office
  525. Xbackbone
  526. Xwiki
  527. Yacht
  528. Your-Spotify
  529. Youtubedl-Material
  530. Yq
  531. Znc
  532. Zotero
  533. Zus.Am

Sources


↕️ Click to Expand ↕️

Full credit to the authors of the following templates. The main templates.json file is composes of these sources, along with the content of the sources directory.

  1. template by @dnburgess
  2. template by @Qballjos
  3. template by @SelfhostedPro
  4. template by @technorabilia
  5. template by @mikestraney
  6. template by @xneo1
  7. template by @novaspirit
  8. template by @donpablonow
  9. template by @mediadepot
  10. template by @mycroftwilde
  11. template by @mediadepot
  12. template by @shmolf
  13. template by @portainer

Raising Issues

If you notice something not working as it should in any of the lib/ scripts, website code, README documentation, or workflows automations - then raise an issue or PR in this repository.

If you encounter an issue with any container included here, please raise a ticket/PR on the up-stream repo, not in this repository. This project simply compiles templates listed in the Sources into a single manifest, so once a fix has been pushed out upstream, it will be available here.


Contributing

Contributions of any kind are very welcome, and would be much appreciated. For Code of Conduct, see Contributor Convent.

Not a coder? You can still help, by raising bugs you find, updating docs, or consider sponsoring me on GitHub

For a guide on adding templates, see the Editing section above (TLDR; either update sources.csv, or paste your template collection into the ./sources directory). Or, to make changes to the website, see the Website section below.

Before raising an issue or editing a template, please see the Raising Issues section above (TL;DR: changes need to be made upstream, NOT in this repo).

If you're new to open source, I've put together some guides in Git-In, but feel free to reach out if you need any support.


Website

There's a simple website, which lists all available templates and shows stats, config options and installation instructions for each app / stack. You can view it at portainer-templates.netlify.app

The source is located in the website branch, and it's build as a simple SSR Svelte app (using SvelteKit + TypeScript + SCSS + Vite). To make changes to the website, you'll need Node.js and Git installed. Then just run the following commands:

git clone -b website git@github.com:Lissy93/portainer-templates.git # Clone the website branch
cd portainer-templates # Navigate into the directory
npm i # Install dependencies
npm run dev # Start the development server

And to pubish, run npm run build then either use npm start or host the content of the '/build' directory using a web server of your choice. Alternatively, there's a Dockerfile, for easy deployment :)

Note that it's not required to make any changes to the website when adding a new template or templates source, as data is fetched directly from templates.json in the repo's main branch - so should show up automatically once your changes are merged.


Mirror

There's a mirror of this repository, maintained on CodeBerg at: codeberg.org/alicia/portainer-templates

To pull templates from there, instead of GitHub, use this URL in your Portainer instance instead:

https://codeberg.org/alicia/portainer-templates/raw/branch/main/templates.json

Credits

Contributors

liss-bot
Alicia Bot
Lissy93
Alicia Sykes
shmolf
Nicholas Browning
Benoniy
Benjamin Ranson
tempusthales
Gilbert Palau
kr40
Kartik Rao
leetrout
Lee Trout
balzack
Pierre Balzack

Sponsors

github
GitHub
koconder
Vincent Koc
Admonstrator
Aaron Viehl
tbjers
Torgny Bjers
AnandChowdhary
Anand Chowdhary
shrippen
Shrippen
bile0026
Zach Biles
UlisesGascon
Ulises Gascón
digitalarche
Digital Archeology
InDieTasten
InDieTasten
araguaci
Araguaci
bmcgonag
Brian McGonagill
vlad-tim
Vlad
helixzz
HeliXZz
patvdv
Patrick Van Der Veken
plgonzalezrx8
Pedro Gonzalez
mryesiller
Göksel Yeşiller
forwardemail
Forward Email - Open-source & Privacy-focused Email Service (2023)
Bastii717
Bastii717
getumbrel
Umbrel
M2TD
M2TD
frankdez93
Frankdez93
terminaltrove
Terminal Trove
NixyJuppie
Nixy
nrvo
Nrvo

License

Note For licenses for each app listed here, see their websites (linked to above).

Lissy93/Portainer-Templates is licensed under MIT © Alicia Sykes 2023.
For information, see TLDR Legal > MIT

Expand License
The MIT License (MIT)
Copyright (c) Alicia Sykes <alicia@omg.com> 

Permission is hereby granted, free of charge, to any person obtaining a copy 
of this software and associated documentation files (the "Software"), to deal 
in the Software without restriction, including without limitation the rights 
to use, copy, modify, merge, publish, distribute, sub-license, and/or sell 
copies of the Software, and to permit persons to whom the Software is furnished 
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included install 
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANT ABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

© Alicia Sykes 2023
Licensed under MIT

Thanks for visiting :)